Platform Explorer / Nuxeo Platform 2023.8

Component org.nuxeo.ecm.directory.GenericDirectory

Documentation

Registration of generic directories.

Requirements

Resolution Order

800
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

829
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.directory.GenericDirectoryComponent

Extension Points

XML Source

<?xml version='1.0' encoding='UTF-8'?>
<component name="org.nuxeo.ecm.directory.GenericDirectory">

  <require>org.nuxeo.ecm.directory.DirectoryServiceImpl</require>

  <implementation class="org.nuxeo.ecm.directory.GenericDirectoryComponent"/>

  <documentation>
    Registration of generic directories.
  </documentation>

  <extension-point name="directories">

    <documentation>
      Registration of generic directories. Generic directories are usable only as extensions to
      other directories which have been defined as templates.

      First, register a template directory:
      <code>
        <extension target="org.nuxeo.ecm.directory.sql.SQLDirectoryFactory" point="directories">
          <directory name="template-dir" template="true">
            <dataSource>java:/nxsqldirectory</dataSource>
            <createTablePolicy>always</createTablePolicy>
            <querySizeLimit>100</querySizeLimit>
          </directory>
        </extension>
      </code>
      Then use a generic directory to provide specific customizations:
      <code>
        <extension target="org.nuxeo.ecm.directory.GenericDirectory" point="directories">
          <directory name="my-directory" extends="template-dir">
            <schema>myschema</schema>
            <table>mytable</table>
            <idField>id</idField>
            <passwordField>password</passwordField>
            <passwordHashAlgorithm>SSHA</passwordHashAlgorithm>
            <substringMatchType>subany</substringMatchType>
            <cacheTimeout>3600</cacheTimeout>
            <cacheMaxSize>1000</cacheMaxSize>
            <!-- <dataFile>my-directory.csv</dataFile> -->
          </directory>
        </extension>
      </code>
    </documentation>

    <object class="org.nuxeo.ecm.directory.BaseDirectoryDescriptor"/>

  </extension-point>

</component>